/* 
 * Shuriken is the legal property of its developers. Please refer to the
 * COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;
using System.Text;
using Shuriken.Core.Ranking;
using Shuriken.Base; 

namespace Shuriken.Core.Store
{
    /// <summary>
    /// Defines the methods and properties needed for being shown on the UI.
    /// </summary>
    public interface ISearchable : IObject 
    {
        /// <summary>
        /// Current rank calculated for this item
        /// </summary>
        double Rank
        {
            get;
            set;
        }

        /// <summary>
        /// Last search term used to select this item 
        /// </summary>
        string SearchTerm
        {
            get;
            set; 
        }

        /// <summary>
        /// Hitmask for this item
        /// </summary>
        MutableIndexSet HitMask
        {
            get;
            set; 
        }

        /// <summary>
        /// 
        /// </summary>
        string UniqueIdentifier
        {
            get; 
        }
    }
}
